
<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Index &#8212; PCB-Layout-Framework  documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#G"><strong>G</strong></a>
 | <a href="#K"><strong>K</strong></a>
 
</div>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="database.html#_CPPv426getBoardBoundaryByEdgeCutsRdRdRdRd">getBoardBoundaryByEdgeCuts (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv429getBoardBoundaryByPinLocationRdRdRdRd">getBoardBoundaryByPinLocation (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer16get_overlap_costEv">GridBasedPlacer::get_overlap_cost (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer15get_temperatureEv">GridBasedPlacer::get_temperature (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer14get_total_costEv">GridBasedPlacer::get_total_cost (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer19get_wirelength_costEv">GridBasedPlacer::get_wirelength_cost (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer12set_base_lamEd">GridBasedPlacer::set_base_lam (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer9set_bb_ecEb">GridBasedPlacer::set_bb_ec (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer23set_initial_move_radiusEd">GridBasedPlacer::set_initial_move_radius (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer23set_initial_temperatureEd">GridBasedPlacer::set_initial_temperature (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer20set_iterations_movesEi">GridBasedPlacer::set_iterations_moves (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer7set_lamEb">GridBasedPlacer::set_lam (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer19set_lambda_scheduleEd">GridBasedPlacer::set_lambda_schedule (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer18set_lamtemp_updateEd">GridBasedPlacer::set_lamtemp_update (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer18set_num_iterationsEi">GridBasedPlacer::set_num_iterations (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer9set_rtreeEb">GridBasedPlacer::set_rtree (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer13set_two_sidedEb">GridBasedPlacer::set_two_sided (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer21set_wirelength_weightEd">GridBasedPlacer::set_wirelength_weight (C++ function)</a>
</li>
      <li><a href="placer.html#_CPPv4N15GridBasedPlacer17test_hplacer_flowEv">GridBasedPlacer::test_hplacer_flow (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv415GridBasedRouter">GridBasedRouter (C++ class)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter30get_diagonal_wirelength_weightEv">GridBasedRouter::get_diagonal_wirelength_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter20get_enlarge_boundaryEv">GridBasedRouter::get_enlarge_boundary (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter14get_grid_scaleEv">GridBasedRouter::get_grid_scale (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter23get_layer_change_weightEv">GridBasedRouter::get_layer_change_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter18get_num_iterationsEv">GridBasedRouter::get_num_iterations (C++ function)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="router.html#_CPPv4N15GridBasedRouter23get_pad_obstacle_weightEv">GridBasedRouter::get_pad_obstacle_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter20get_routed_num_bendsERNSt6vectorI13MultipinRouteEE">GridBasedRouter::get_routed_num_bends (C++ function)</a>, <a href="router.html#_CPPv4N15GridBasedRouter20get_routed_num_bendsEv">[1]</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter19get_routed_num_viasERNSt6vectorI13MultipinRouteEE">GridBasedRouter::get_routed_num_vias (C++ function)</a>, <a href="router.html#_CPPv4N15GridBasedRouter19get_routed_num_viasEv">[1]</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter21get_routed_wirelengthERNSt6vectorI13MultipinRouteEE">GridBasedRouter::get_routed_wirelength (C++ function)</a>, <a href="router.html#_CPPv4N15GridBasedRouter21get_routed_wirelengthEv">[1]</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter14get_total_costEv">GridBasedRouter::get_total_cost (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter28get_track_obstacle_step_sizeEv">GridBasedRouter::get_track_obstacle_step_size (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter25get_track_obstacle_weightEv">GridBasedRouter::get_track_obstacle_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter26get_via_obstacle_step_sizeEv">GridBasedRouter::get_via_obstacle_step_size (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter23get_via_obstacle_weightEv">GridBasedRouter::get_via_obstacle_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter21get_wirelength_weightEv">GridBasedRouter::get_wirelength_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter15GridBasedRouterER16kicadPcbDataBase">GridBasedRouter::GridBasedRouter (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter14initializationEv">GridBasedRouter::initialization (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter5routeEv">GridBasedRouter::route (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter30set_diagonal_wirelength_weightEKd">GridBasedRouter::set_diagonal_wirelength_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter20set_enlarge_boundaryEKi">GridBasedRouter::set_enlarge_boundary (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter14set_grid_scaleEKi">GridBasedRouter::set_grid_scale (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter23set_layer_change_weightEKd">GridBasedRouter::set_layer_change_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter31set_net_all_layers_pref_weightsEKiKi">GridBasedRouter::set_net_all_layers_pref_weights (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter25set_net_layer_pref_weightEKiRKNSt6stringEKi">GridBasedRouter::set_net_layer_pref_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter18set_num_iterationsEKi">GridBasedRouter::set_num_iterations (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter23set_pad_obstacle_weightEKd">GridBasedRouter::set_pad_obstacle_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter28set_track_obstacle_step_sizeEKd">GridBasedRouter::set_track_obstacle_step_size (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter25set_track_obstacle_weightEKd">GridBasedRouter::set_track_obstacle_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter26set_via_obstacle_step_sizeEKd">GridBasedRouter::set_via_obstacle_step_size (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter23set_via_obstacle_weightEKd">GridBasedRouter::set_via_obstacle_weight (C++ function)</a>
</li>
      <li><a href="router.html#_CPPv4N15GridBasedRouter21set_wirelength_weightEKd">GridBasedRouter::set_wirelength_weight (C++ function)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="K">K</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="database.html#_CPPv416kicadPcbDataBase">kicadPcbDataBase (C++ class)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase13buildKicadPcbEv">kicadPcbDataBase::buildKicadPcb (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase11getCompBBoxEKiP8point_2d">kicadPcbDataBase::getCompBBox (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase12getComponentEKi">kicadPcbDataBase::getComponent (C++ function)</a>, <a href="database.html#_CPPv4N16kicadPcbDataBase12getComponentERKNSt6stringERP9component">[1]</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase13getComponentsEv">kicadPcbDataBase::getComponents (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase15getCopperLayersEv">kicadPcbDataBase::getCopperLayers (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase11getFileNameEv">kicadPcbDataBase::getFileName (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase11getInstanceEKi">kicadPcbDataBase::getInstance (C++ function)</a>, <a href="database.html#_CPPv4N16kicadPcbDataBase11getInstanceERKNSt6stringERP8instance">[1]</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase12getInstancesEv">kicadPcbDataBase::getInstances (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase17getInstancesCountEv">kicadPcbDataBase::getInstancesCount (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase19getLargestClearanceEv">kicadPcbDataBase::getLargestClearance (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase10getLayerIdERKNSt6stringE">kicadPcbDataBase::getLayerId (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase12getLayerNameEKi">kicadPcbDataBase::getLayerName (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase6getNetEKi">kicadPcbDataBase::getNet (C++ function)</a>, <a href="database.html#_CPPv4N16kicadPcbDataBase6getNetERKNSt6stringERP3net">[1]</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase11getNetclassEKi">kicadPcbDataBase::getNetclass (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase13getNetclassesEv">kicadPcbDataBase::getNetclasses (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase7getNetsEv">kicadPcbDataBase::getNets (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase18getNumCopperLayersEv">kicadPcbDataBase::getNumCopperLayers (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase10getNumNetsEv">kicadPcbDataBase::getNumNets (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase32getPadstackRotatedWidthAndHeightERK8instanceRK8padstackRdRd">kicadPcbDataBase::getPadstackRotatedWidthAndHeight (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase16getPcbRouterInfoEPNSt6vectorINSt3setINSt4pairIddEEEEEE">kicadPcbDataBase::getPcbRouterInfo (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase11getPinLayerERKiRKi">kicadPcbDataBase::getPinLayer (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase14getPinPositionEKiRKiP8point_2d">kicadPcbDataBase::getPinPosition (C++ function)</a>, <a href="database.html#_CPPv4N16kicadPcbDataBase14getPinPositionERK3PinP8point_2d">[1]</a>, <a href="database.html#_CPPv4N16kicadPcbDataBase14getPinPositionERK8padstackRK8instanceP8point_2d">[2]</a>, <a href="database.html#_CPPv4N16kicadPcbDataBase14getPinPositionERKNSt6stringERKNSt6stringEP8point_2d">[3]</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase33getPinShapeRelativeCoordsToModuleERK8padstackRK8instanceRK9points_2dP9points_2d">kicadPcbDataBase::getPinShapeRelativeCoordsToModule (C++ function)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase18getUnconnectedPinsEv">kicadPcbDataBase::getUnconnectedPins (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase13isComponentIdEKi">kicadPcbDataBase::isComponentId (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase13isCopperLayerEKi">kicadPcbDataBase::isCopperLayer (C++ function)</a>, <a href="database.html#_CPPv4N16kicadPcbDataBase13isCopperLayerERKNSt6stringE">[1]</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase12isInstanceIdEKi">kicadPcbDataBase::isInstanceId (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase12isNetclassIdEKi">kicadPcbDataBase::isNetclassId (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase7isNetIdEKi">kicadPcbDataBase::isNetId (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase16kicadPcbDataBaseENSt6stringE">kicadPcbDataBase::kicadPcbDataBase (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase17printClearanceDrcEv">kicadPcbDataBase::printClearanceDrc (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase9printCompEv">kicadPcbDataBase::printComp (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase21printDesignStatisticsEv">kicadPcbDataBase::printDesignStatistics (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase9printFileEv">kicadPcbDataBase::printFile (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase9printInstEv">kicadPcbDataBase::printInst (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase10printKiCadEKNSt6stringEKNSt6stringEKNSt6stringEKb">kicadPcbDataBase::printKiCad (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase10printLayerEv">kicadPcbDataBase::printLayer (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase15printLockedInstEv">kicadPcbDataBase::printLockedInst (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase8printNetEv">kicadPcbDataBase::printNet (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase13printNetclassEv">kicadPcbDataBase::printNetclass (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase10printNodesEv">kicadPcbDataBase::printNodes (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase18printPcbRouterInfoEv">kicadPcbDataBase::printPcbRouterInfo (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase31printRoutedSegmentsWLAndNumViasEv">kicadPcbDataBase::printRoutedSegmentsWLAndNumVias (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase12printSegmentEv">kicadPcbDataBase::printSegment (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase20printUnconnectedPinsEv">kicadPcbDataBase::printUnconnectedPins (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase27removeRoutedSegmentsAndViasEv">kicadPcbDataBase::removeRoutedSegmentsAndVias (C++ function)</a>
</li>
      <li><a href="database.html#_CPPv4N16kicadPcbDataBase13testInstAngleEv">kicadPcbDataBase::testInstAngle (C++ function)</a>
</li>
  </ul></td>
</tr></table>



          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">PCB-Layout-Framework</a></h1>








<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="database.html">API for Database</a></li>
<li class="toctree-l1"><a class="reference internal" href="placer.html">API for Placer</a></li>
<li class="toctree-l1"><a class="reference internal" href="router.html">API for Router</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, [blinded for review].
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.0</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
    </div>

    

    
  </body>
</html>